/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.muni.fi.pa165.creatures.dao;

import cz.muni.fi.pa165.creatures.model.CreatureType;
import cz.muni.fi.pa165.creatures.model.CreatureTypeWeapon;
import cz.muni.fi.pa165.creatures.model.Weapon;
import java.util.List;

/**
 * This interface represents a contract for implementation of the DAO for the
 * {@link cz.muni.fi.pa165.creatures.model.CreatureTypeWeapon} entity.
 *
 * @author smikloso
 */
public interface CreatureTypeWeaponDAO {

    /**
     * This method creates a creature.
     *
     * @param creatureTypeWeapon creatureTypeWeapon to create
     */
    void create(CreatureTypeWeapon creatureTypeWeapon);

    /**
     * This method removes a creatureTypeWeapon.
     *
     * @param creatureTypeWeapon creatureTypeWeapon to remove
     */
    void remove(CreatureTypeWeapon creatureTypeWeapon);

    /**
     * This method updates already existing creatureTypeWeapon.
     *
     * @param creatureTypeWeapon creatureTypeWeapon to update
     */
    void update(CreatureTypeWeapon creatureTypeWeapon);

    /**
     * This method gets association class between
     * {@link cz.muni.fi.pa165.creatures.model.CreatureType} and
     * {@link cz.muni.fi.pa165.creatures.model.Weapon}.
     *
     * @param creatureType type of creature to get association of
     * @param weapon weapon associated with creature for getting the association
     * @return association class between {@code creatureType} and {@code weapon}
     */
    CreatureTypeWeapon get(CreatureType creatureType, Weapon weapon);

    /**
     * This method returns count of creatureTypeWeapons in our simple world.
     *
     * @return number of the all {@code creatureTypeWeapon}s
     */
    Long getCount();

    /**
     * This method returns all {@code creatureTypeWeapon}s in our simple world.
     *
     * @return a list of all {@code creatureTypeWeapon}s, if there are no
     * {@code creatureTypeWeapon}s, the returned list is an empty list, not null
     */
    List<CreatureTypeWeapon> getAll();
}
